FoxitPDFSDKPython3.StructElement类 参考
类 FoxitPDFSDKPython3.StructElement 继承关系图:
Public 成员函数 | |
| def | StructElement () |
| 构造函数。 更多... | |
| def | GetChild (index) |
| 通过索引获取子结构树实体。 更多... | |
| def | GetChildCount () |
| 获取当前结构元素中子结构树实体的数量。 更多... | |
| def | GetElementInfo (type) |
| 获取结构元素信息。 更多... | |
| def | GetParentElement () |
| 获取父结构元素。 更多... | |
| def | GetStructureTypeName () |
| 获取结构类型名称。 更多... | |
| def | HasElementInfo (type) |
| 检查特定类型的结构元素信息是否存在。 更多... | |
| def | RemoveChild (index) |
| 通过索引删除子结构树实体。 更多... | |
 Public 成员函数 继承自 FoxitPDFSDKPython3.StructTreeEntity | |
| def | StructTreeEntity () |
| 构造函数。 更多... | |
| def | GetPage () |
| 获取相关的PDF页面。 更多... | |
| def | GetType () |
| 获取结构树实体类型。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
静态 Public 属性 | |
| e_ElementInfoTypeActualText = _fsdk.StructElement_e_ElementInfoTypeActualText | |
| 结构元素信息类型：Actual Text，表示结构元素的实际文本。 | |
| e_ElementInfoTypeAltDescription = _fsdk.StructElement_e_ElementInfoTypeAltDescription | |
| 结构元素信息类型：Alternative Description，表示结构元素的替代描述。 | |
| e_ElementInfoTypeExpandedForm = _fsdk.StructElement_e_ElementInfoTypeExpandedForm | |
| 结构元素信息类型：Expanded Form，表示结构元素的扩展形式。 | |
| e_ElementInfoTypeLanguage = _fsdk.StructElement_e_ElementInfoTypeLanguage | |
| 结构元素信息类型：Language，表示结构元素中所有文本的 自然语言，除非被嵌套结构元素或标记内容的语言规范覆盖。 | |
| e_ElementInfoTypeTitle = _fsdk.StructElement_e_ElementInfoTypeTitle | |
| 结构元素信息类型：Title，表示结构元素的标题。以人类可读形式表示的文本字符串。 | |
| 静态 Public 属性 继承自 FoxitPDFSDKPython3.StructTreeEntity | |
| e_StructTreeEntityTypeElement = _fsdk.StructTreeEntity_e_StructTreeEntityTypeElement | |
| 结构树实体类型：Element，表示结构元素。 | |
| e_StructTreeEntityTypeMarkedContent = _fsdk.StructTreeEntity_e_StructTreeEntityTypeMarkedContent | |
| 结构树实体类型：MarkedContent，表示标记内容项。 | |
| e_StructTreeEntityTypeObjectContent = _fsdk.StructTreeEntity_e_StructTreeEntityTypeObjectContent | |
| 结构树实体类型：ObjectContent，表示PDF对象内容项， 如注释和XObject。 | |
| e_UnknownType = _fsdk.StructTreeEntity_e_UnknownType | |
| 结构树实体类型：未知。 | |
详细描述
此类表示结构元素。
构造及析构函数说明
◆ StructElement()
| def FoxitPDFSDKPython3.StructElement.StructElement | ( | ) |
构造函数。
拷贝构造函数。
- 参数
-
[in] other 另一个结构元素对象。
成员函数说明
◆ GetChild()
| def FoxitPDFSDKPython3.StructElement.GetChild | ( | index | ) |
通过索引获取子结构树实体。
- 参数
-
[in] index 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.StructElement.GetChildCount 返回。
- 返回
- 一个子结构树实体对象。
◆ GetChildCount()
| def FoxitPDFSDKPython3.StructElement.GetChildCount | ( | ) |
获取当前结构元素中子结构树实体的数量。
- 返回
- 子结构树实体的数量。
◆ GetElementInfo()
| def FoxitPDFSDKPython3.StructElement.GetElementInfo | ( | type | ) |
获取结构元素信息。
在获取结构元素信息之前，请确保已调用函数FoxitPDFSDKPython3.StructElement.HasElementInfo 并返回true（使用相应的类型）。
- 参数
-
[in] type 结构元素信息类型。请参考从FoxitPDFSDKPython3.StructElement.e_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。
- 返回
- 结构元素信息字符串。
◆ GetParentElement()
| def FoxitPDFSDKPython3.StructElement.GetParentElement | ( | ) |
获取父结构元素。
- 返回
- 父结构元素。如果返回对象的函数StructElement::IsEmpty返回true， 这意味着当前元素没有父元素。
◆ GetStructureTypeName()
| def FoxitPDFSDKPython3.StructElement.GetStructureTypeName | ( | ) |
获取结构类型名称。
每个结构元素都应该有一个结构类型，这是一个名称对象，用于标识 结构元素的性质及其在文档中的角色（例如章节、段落或脚注）。 有关更多详细信息，请参考<PDF Reference 1.7>第10.7.3节中对"标准结构类型"的描述或 <PDF Reference 2.0>第14.8.4节中对"标准结构类型"的描述。
- 返回
- 表示当前结构元素的结构类型名称的字符串。
◆ HasElementInfo()
| def FoxitPDFSDKPython3.StructElement.HasElementInfo | ( | type | ) |
检查特定类型的结构元素信息是否存在。
- 参数
-
[in] type 结构元素信息类型。请参考从FoxitPDFSDKPython3.StructElement.e_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。
- 返回
- true表示元素信息类型有元素信息， 而false表示元素信息类型没有元素信息。
◆ RemoveChild()
| def FoxitPDFSDKPython3.StructElement.RemoveChild | ( | index | ) |
通过索引删除子结构树实体。
- 参数
-
[in] index 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.StructElement.GetChildCount 返回。
- 返回
- 无。
